<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: Spec::Runner::OptionParser</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">Spec::Runner::OptionParser</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../../files/vendor\plugins\rspec/lib/spec/runner/option_parser_rb.html">
                vendor\plugins\rspec/lib/spec/runner/option_parser.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="../../Object.html">
                Object
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">



   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000348">create_behaviour_runner</a>&nbsp;&nbsp;
      <a href="#M000347">new</a>&nbsp;&nbsp;
      <a href="#M000349">parse</a>&nbsp;&nbsp;
      <a href="#M000351">parse_drb</a>&nbsp;&nbsp;
      <a href="#M000353">parse_help</a>&nbsp;&nbsp;
      <a href="#M000350">parse_options_file</a>&nbsp;&nbsp;
      <a href="#M000352">parse_version</a>&nbsp;&nbsp;
      <a href="#M000354">set_spec_from_line_number</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">


    <div id="constants-list">
      <h3 class="section-bar">Constants</h3>

      <div class="name-list">
        <table summary="Constants">
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">BUILT_IN_FORMATTERS</td>
          <td>=</td>
          <td class="context-item-value">{         'specdoc'  =&gt; Formatter::SpecdocFormatter,         's'        =&gt; Formatter::SpecdocFormatter,         'html'     =&gt; Formatter::HtmlFormatter,         'h'        =&gt; Formatter::HtmlFormatter,         'rdoc'     =&gt; Formatter::RdocFormatter,         'r'        =&gt; Formatter::RdocFormatter,         'progress' =&gt; Formatter::ProgressBarFormatter,         'p'        =&gt; Formatter::ProgressBarFormatter,         'failing_examples' =&gt; Formatter::FailingExamplesFormatter,         'e'        =&gt; Formatter::FailingExamplesFormatter,         'failing_behaviours' =&gt; Formatter::FailingBehavioursFormatter,         'b'        =&gt; Formatter::FailingBehavioursFormatter</td>
        </tr>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">COMMAND_LINE</td>
          <td>=</td>
          <td class="context-item-value">{         :diff =&gt;    [&quot;-D&quot;, &quot;--diff [FORMAT]&quot;, &quot;Show diff of objects that are expected to be equal when they are not&quot;,                                              &quot;Builtin formats: unified|u|context|c&quot;,                                              &quot;You can also specify a custom differ class&quot;,                                              &quot;(in which case you should also specify --require)&quot;],         :colour =&gt;  [&quot;-c&quot;, &quot;--colour&quot;, &quot;--color&quot;, &quot;Show coloured (red/green) output&quot;],         :example =&gt; [&quot;-e&quot;, &quot;--example [NAME|FILE_NAME]&quot;,  &quot;Execute example(s) with matching name(s). If the argument is&quot;,                                                           &quot;the path to an existing file (typically generated by a previous&quot;,                                                           &quot;run using --format failing_examples:file.txt), then the examples&quot;,                                                           &quot;on each line of thatfile will be executed. If the file is empty,&quot;,                                                           &quot;all examples will be run (as if --example was not specified).&quot;,                                                           &quot; &quot;,                                                           &quot;If the argument is not an existing file, then it is treated as&quot;,                                                           &quot;an example name directly, causing RSpec to run just the example&quot;,                                                           &quot;matching that name&quot;],         :specification =&gt; [&quot;-s&quot;, &quot;--specification [NAME]&quot;, &quot;DEPRECATED - use -e instead&quot;, &quot;(This will be removed when autotest works with -e)&quot;],         :line =&gt; [&quot;-l&quot;, &quot;--line LINE_NUMBER&quot;, Integer, &quot;Execute behaviout or specification at given line.&quot;,                                                        &quot;(does not work for dynamically generated specs)&quot;],         :format =&gt; [&quot;-f&quot;, &quot;--format FORMAT[:WHERE]&quot;,  &quot;Specifies what format to use for output. Specify WHERE to tell&quot;,                                                     &quot;the formatter where to write the output. All built-in formats&quot;,                                                     &quot;expect WHERE to be a file name, and will write to STDOUT if it's&quot;,                                                     &quot;not specified. The --format option may be specified several times&quot;,                                                     &quot;if you want several outputs&quot;,                                                     &quot; &quot;,                                                     &quot;Builtin formats: &quot;,                                                     &quot;progress|p           : Text progress&quot;,                                                     &quot;specdoc|s            : Behaviour doc as text&quot;,                                                     &quot;rdoc|r               : Behaviour doc as RDoc&quot;,                                                     &quot;html|h               : A nice HTML report&quot;,                                                     &quot;failing_examples|e   : Write all failing examples - input for --example&quot;,                                                     &quot;failing_behaviours|b : Write all failing behaviours - input for --example&quot;,                                                     &quot; &quot;,                                                     &quot;FORMAT can also be the name of a custom formatter class&quot;,                                                     &quot;(in which case you should also specify --require to load it)&quot;],         :require =&gt; [&quot;-r&quot;, &quot;--require FILE&quot;, &quot;Require FILE before running specs&quot;,                                           &quot;Useful for loading custom formatters or other extensions.&quot;,                                           &quot;If this option is used it must come before the others&quot;],         :backtrace =&gt; [&quot;-b&quot;, &quot;--backtrace&quot;, &quot;Output full backtrace&quot;],         :loadby =&gt; [&quot;-L&quot;, &quot;--loadby STRATEGY&quot;, &quot;Specify the strategy by which spec files should be loaded.&quot;,                                               &quot;STRATEGY can currently only be 'mtime' (File modification time)&quot;,                                               &quot;By default, spec files are loaded in alphabetical order if --loadby&quot;,                                               &quot;is not specified.&quot;],         :reverse =&gt; [&quot;-R&quot;, &quot;--reverse&quot;, &quot;Run examples in reverse order&quot;],         :timeout =&gt; [&quot;-t&quot;, &quot;--timeout FLOAT&quot;, &quot;Interrupt and fail each example that doesn't complete in the&quot;,                                               &quot;specified time&quot;],         :heckle =&gt; [&quot;-H&quot;, &quot;--heckle CODE&quot;, &quot;If all examples pass, this will mutate the classes and methods&quot;,                                            &quot;identified by CODE little by little and run all the examples again&quot;,                                            &quot;for each mutation. The intent is that for each mutation, at least&quot;,                                            &quot;one example *should* fail, and RSpec will tell you if this is not the&quot;,                                            &quot;case. CODE should be either Some::Module, Some::Class or&quot;,                                            &quot;Some::Fabulous#method}&quot;],         :dry_run =&gt; [&quot;-d&quot;, &quot;--dry-run&quot;, &quot;Invokes formatters without executing the examples.&quot;],         :options_file =&gt; [&quot;-O&quot;, &quot;--options PATH&quot;, &quot;Read options from a file&quot;],         :generate_options =&gt; [&quot;-G&quot;, &quot;--generate-options PATH&quot;, &quot;Generate an options file for --options&quot;],         :runner =&gt; [&quot;-U&quot;, &quot;--runner RUNNER&quot;, &quot;Use a custom BehaviourRunner.&quot;],         :drb =&gt; [&quot;-X&quot;, &quot;--drb&quot;, &quot;Run examples via DRb. (For example against script/spec_server)&quot;],         :version =&gt; [&quot;-v&quot;, &quot;--version&quot;, &quot;Show version&quot;],         :help =&gt; [&quot;-h&quot;, &quot;--help&quot;, &quot;You're looking at it&quot;]</td>
        </tr>
        </table>
      </div>
    </div>



      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000347" class="method-detail">
        <a name="M000347"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000347.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000347.html');return false;">
          <span class="method-name">new</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000348" class="method-detail">
        <a name="M000348"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000348.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000348.html');return false;">
          <span class="method-name">create_behaviour_runner</span><span class="method-args">(args, err, out, warn_if_no_files)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000349" class="method-detail">
        <a name="M000349"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000349.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000349.html');return false;">
          <span class="method-name">parse</span><span class="method-args">(args, err, out, warn_if_no_files)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000351" class="method-detail">
        <a name="M000351"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000351.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000351.html');return false;">
          <span class="method-name">parse_drb</span><span class="method-args">(args_copy, out_stream, error_stream, warn_if_no_files)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000353" class="method-detail">
        <a name="M000353"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000353.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000353.html');return false;">
          <span class="method-name">parse_help</span><span class="method-args">(opts, out_stream)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000350" class="method-detail">
        <a name="M000350"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000350.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000350.html');return false;">
          <span class="method-name">parse_options_file</span><span class="method-args">(options_file, out_stream, error_stream, args_copy, warn_if_no_files)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000352" class="method-detail">
        <a name="M000352"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000352.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000352.html');return false;">
          <span class="method-name">parse_version</span><span class="method-args">(out_stream)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000354" class="method-detail">
        <a name="M000354"></a>

        <div class="method-heading">
          <a href="OptionParser.src/M000354.html" target="Code" class="method-signature"
            onclick="popupCode('OptionParser.src/M000354.html');return false;">
          <span class="method-name">set_spec_from_line_number</span><span class="method-args">(options, args, err)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>